IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3x / curs_getch.z / curs_getch

Wrap

Text File | 2002-10-03 | 18.5 KB | 333 lines

ccccuuuurrrrssss____ggggeeeettttcccchhhh((((3333XXXX)))) ccccuuuurrrrssss____ggggeeeettttcccchhhh((((3333XXXX)))) NNNNAAAAMMMMEEEE _cccc_uuuu_rrrr_ssss______gggg_eeee_tttt_cccc_hhhh: _gggg_eeee_tttt_cccc_hhhh, _wwww_gggg_eeee_tttt_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_cccc_hhhh, _mmmm_vvvv_wwww_gggg_eeee_tttt_cccc_hhhh, _uuuu_nnnn_gggg_eeee_tttt_cccc_hhhh - get (or push back) characters from _cccc_uuuu_rrrr_ssss_eeee_ssss terminal keyboard SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> _iiii_nnnn_tttt _gggg_eeee_tttt_cccc_hhhh_((((_vvvv_oooo_iiii_dddd_))))_;;;; _iiii_nnnn_tttt _wwww_gggg_eeee_tttt_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;; _iiii_nnnn_tttt _mmmm_vvvv_gggg_eeee_tttt_cccc_hhhh_((((_iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_))))_;;;; _iiii_nnnn_tttt _mmmm_vvvv_wwww_gggg_eeee_tttt_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_))))_;;;; _iiii_nnnn_tttt _uuuu_nnnn_gggg_eeee_tttt_cccc_hhhh_((((_iiii_nnnn_tttt _cccc_hhhh_))))_;;;; DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The _gggg_eeee_tttt_cccc_hhhh, _wwww_gggg_eeee_tttt_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_cccc_hhhh, and _mmmm_vvvv_wwww_gggg_eeee_tttt_cccc_hhhh routines read a character from the terminal associated with the window. In no-delay mode, if no input is waiting, the value _EEEE_RRRR_RRRR is returned. In delay mode, the program waits until the system passes text through to the program. Depending on the setting of _cccc_bbbb_rrrr_eeee_aaaa_kkkk, this is after one character (_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode), or after the first newline (_nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode). In half-delay mode, the program waits until a character is typed or the specified timeout has been reached. Unless _nnnn_oooo_eeee_cccc_hhhh_oooo has been set, the character will also be echoed into the designated window. If the window is not a pad, and it has been moved or modified since the last call to _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh will be called before another character is read. If _kkkk_eeee_yyyy_pppp_aaaa_dddd is _TTTT_RRRR_UUUU_EEEE, and a function key is pressed, the token for that function key is returned instead of the raw characters. Possible function keys are defined in _cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh with integers beginning with _0000_4444_0000_1111, whose names begin with _KKKK_EEEE_YYYY______.... If a character that could be the beginning of a function key (such as escape) is received, _cccc_uuuu_rrrr_ssss_eeee_ssss sets a timer. If the remainder of the sequence does not come in within the designated time, the character is passed through; otherwise, the function key value is returned. For this reason, many terminals experience a delay between the time a user presses the escape key and the escape is returned to the program. Since tokens returned by these routines are outside the ASCII range, they are not printable. The _uuuu_nnnn_gggg_eeee_tttt_cccc_hhhh routine places _c_h back onto the input queue to be returned by the next call to _wwww_gggg_eeee_tttt_cccc_hhhh. FFFFuuuunnnnccccttttiiiioooonnnn KKKKeeeeyyyyssss The following function keys, defined in _cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh, might be returned by _gggg_eeee_tttt_cccc_hhhh if _kkkk_eeee_yyyy_pppp_aaaa_dddd has been enabled. Note that not all of these may be supported on a particular terminal if the terminal does not transmit a unique code when the key is pressed or if the definition for the key is not present in the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database. PPPPaaaaggggeeee 1111 ccccuuuurrrrssss____ggggeeeettttcccchhhh((((3333XXXX)))) ccccuuuurrrrssss____ggggeeeettttcccchhhh((((3333XXXX)))) __________________________________________________________________ _N_a_m_e Key name __________________________________________________________________ PPPPaaaaggggeeee 2222 _KKKK_EEEE_YYYY______BBBB_RRRR_EEEE_AAAA_KKKK Break key _KKKK_EEEE_YYYY______DDDD_OOOO_WWWW_NNNN The four arrow keys ... _KKKK_EEEE_YYYY______UUUU_PPPP _KKKK_EEEE_YYYY______LLLL_EEEE_FFFF_TTTT _KKKK_EEEE_YYYY______RRRR_IIII_GGGG_HHHH_TTTT _KKKK_EEEE_YYYY______HHHH_OOOO_MMMM_EEEE Home key (upward+left arrow) _KKKK_EEEE_YYYY______BBBB_AAAA_CCCC_KKKK_SSSS_PPPP_AAAA_CCCC_EEEE Backspace _KKKK_EEEE_YYYY______FFFF_0000 Function keys; space for 64 keys is reserved. _KKKK_EEEE_YYYY______FFFF_((((_n_)))) For 0 _< _n _< 63 _KKKK_EEEE_YYYY______DDDD_LLLL Delete line _KKKK_EEEE_YYYY______IIII_LLLL Insert line _KKKK_EEEE_YYYY______DDDD_CCCC Delete character _KKKK_EEEE_YYYY______IIII_CCCC Insert char or enter insert mode _KKKK_EEEE_YYYY______EEEE_IIII_CCCC Exit insert char mode _KKKK_EEEE_YYYY______CCCC_LLLL_EEEE_AAAA_RRRR Clear screen _KKKK_EEEE_YYYY______EEEE_OOOO_SSSS Clear to end of screen _KKKK_EEEE_YYYY______EEEE_OOOO_LLLL Clear to end of line _KKKK_EEEE_YYYY______SSSS_FFFF Scroll 1 line forward _KKKK_EEEE_YYYY______SSSS_RRRR Scroll 1 line backward (reverse) _KKKK_EEEE_YYYY______NNNN_PPPP_AAAA_GGGG_EEEE Next page _KKKK_EEEE_YYYY______PPPP_PPPP_AAAA_GGGG_EEEE Previous page _KKKK_EEEE_YYYY______SSSS_TTTT_AAAA_BBBB Set tab _KKKK_EEEE_YYYY______CCCC_TTTT_AAAA_BBBB Clear tab _KKKK_EEEE_YYYY______CCCC_AAAA_TTTT_AAAA_BBBB Clear all tabs _KKKK_EEEE_YYYY______EEEE_NNNN_TTTT_EEEE_RRRR Enter or send _KKKK_EEEE_YYYY______SSSS_RRRR_EEEE_SSSS_EEEE_TTTT Soft (partial) reset _KKKK_EEEE_YYYY______RRRR_EEEE_SSSS_EEEE_TTTT Reset or hard reset _KKKK_EEEE_YYYY______PPPP_RRRR_IIII_NNNN_TTTT Print or copy Home down or bottom (lower left). Keypad is arranged like this: _AAAA_1111 _uuuu_pppp _AAAA_3333 _llll_eeee_ffff_tttt _BBBB_2222 _rrrr_iiii_gggg_hhhh_tttt _CCCC_1111 _dddd_oooo_wwww_nnnn _CCCC_3333 _KKKK_EEEE_YYYY______LLLL_LLLL _KKKK_EEEE_YYYY______AAAA_1111 Upper left of keypad _KKKK_EEEE_YYYY______AAAA_3333 Upper right of keypad _KKKK_EEEE_YYYY______BBBB_2222 Center of keypad _KKKK_EEEE_YYYY______CCCC_1111 Lower left of keypad _KKKK_EEEE_YYYY______CCCC_3333 Lower right of keypad _KKKK_EEEE_YYYY______BBBB_TTTT_AAAA_BBBB Back tab key _KKKK_EEEE_YYYY______BBBB_EEEE_GGGG Beg(inning) key _KKKK_EEEE_YYYY______CCCC_AAAA_NNNN_CCCC_EEEE_LLLL Cancel key _KKKK_EEEE_YYYY______CCCC_LLLL_OOOO_SSSS_EEEE Close key _KKKK_EEEE_YYYY______CCCC_OOOO_MMMM_MMMM_AAAA_NNNN_DDDD Cmd (command) key _KKKK_EEEE_YYYY______CCCC_OOOO_PPPP_YYYY Copy key _KKKK_EEEE_YYYY______CCCC_RRRR_EEEE_AAAA_TTTT_EEEE Create key _KKKK_EEEE_YYYY______EEEE_NNNN_DDDD End key _KKKK_EEEE_YYYY______EEEE_XXXX_IIII_TTTT Exit key _KKKK_EEEE_YYYY______FFFF_IIII_NNNN_DDDD Find key _KKKK_EEEE_YYYY______HHHH_EEEE_LLLL_PPPP Help key _KKKK_EEEE_YYYY______MMMM_AAAA_RRRR_KKKK Mark key PPPPaaaaggggeeee 3333 _KKKK_EEEE_YYYY______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE Message key _KKKK_EEEE_YYYY______MMMM_OOOO_VVVV_EEEE Move key _KKKK_EEEE_YYYY______NNNN_EEEE_XXXX_TTTT Next object key _KKKK_EEEE_YYYY______OOOO_PPPP_EEEE_NNNN Open key _KKKK_EEEE_YYYY______OOOO_PPPP_TTTT_IIII_OOOO_NNNN_SSSS Options key _KKKK_EEEE_YYYY______PPPP_RRRR_EEEE_VVVV_IIII_OOOO_UUUU_SSSS Previous object key _KKKK_EEEE_YYYY______RRRR_EEEE_DDDD_OOOO Redo key _KKKK_EEEE_YYYY______RRRR_EEEE_FFFF_EEEE_RRRR_EEEE_NNNN_CCCC_EEEE Ref(erence) key _KKKK_EEEE_YYYY______RRRR_EEEE_FFFF_RRRR_EEEE_SSSS_HHHH Refresh key _KKKK_EEEE_YYYY______RRRR_EEEE_PPPP_LLLL_AAAA_CCCC_EEEE Replace key _KKKK_EEEE_YYYY______RRRR_EEEE_SSSS_TTTT_AAAA_RRRR_TTTT Restart key _KKKK_EEEE_YYYY______RRRR_EEEE_SSSS_UUUU_MMMM_EEEE Resume key _KKKK_EEEE_YYYY______SSSS_AAAA_VVVV_EEEE Save key _KKKK_EEEE_YYYY______SSSS_BBBB_EEEE_GGGG Shifted beginning key _KKKK_EEEE_YYYY______SSSS_CCCC_AAAA_NNNN_CCCC_EEEE_LLLL Shifted cancel key _KKKK_EEEE_YYYY______SSSS_CCCC_OOOO_MMMM_MMMM_AAAA_NNNN_DDDD Shifted command key _KKKK_EEEE_YYYY______SSSS_CCCC_OOOO_PPPP_YYYY Shifted copy key _KKKK_EEEE_YYYY______SSSS_CCCC_RRRR_EEEE_AAAA_TTTT_EEEE Shifted create key _KKKK_EEEE_YYYY______SSSS_DDDD_CCCC Shifted delete char key _KKKK_EEEE_YYYY______SSSS_DDDD_LLLL Shifted delete line key _KKKK_EEEE_YYYY______SSSS_EEEE_LLLL_EEEE_CCCC_TTTT Select key _KKKK_EEEE_YYYY______SSSS_EEEE_NNNN_DDDD Shifted end key _KKKK_EEEE_YYYY______SSSS_EEEE_OOOO_LLLL Shifted clear line key _KKKK_EEEE_YYYY______SSSS_EEEE_XXXX_IIII_TTTT Shifted exit key _KKKK_EEEE_YYYY______SSSS_FFFF_IIII_NNNN_DDDD Shifted find key _KKKK_EEEE_YYYY______SSSS_HHHH_EEEE_LLLL_PPPP Shifted help key _KKKK_EEEE_YYYY______SSSS_HHHH_OOOO_MMMM_EEEE Shifted home key _KKKK_EEEE_YYYY______SSSS_IIII_CCCC Shifted input key _KKKK_EEEE_YYYY______SSSS_LLLL_EEEE_FFFF_TTTT Shifted left arrow key _KKKK_EEEE_YYYY______SSSS_MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE Shifted message key _KKKK_EEEE_YYYY______SSSS_MMMM_OOOO_VVVV_EEEE Shifted move key _KKKK_EEEE_YYYY______SSSS_NNNN_EEEE_XXXX_TTTT Shifted next key _KKKK_EEEE_YYYY______SSSS_OOOO_PPPP_TTTT_IIII_OOOO_NNNN_SSSS Shifted options key _KKKK_EEEE_YYYY______SSSS_PPPP_RRRR_EEEE_VVVV_IIII_OOOO_UUUU_SSSS Shifted prev key _KKKK_EEEE_YYYY______SSSS_PPPP_RRRR_IIII_NNNN_TTTT Shifted print key _KKKK_EEEE_YYYY______SSSS_RRRR_EEEE_DDDD_OOOO Shifted redo key _KKKK_EEEE_YYYY______SSSS_RRRR_EEEE_PPPP_LLLL_AAAA_CCCC_EEEE Shifted replace key _KKKK_EEEE_YYYY______SSSS_RRRR_IIII_GGGG_HHHH_TTTT Shifted right arrow _KKKK_EEEE_YYYY______SSSS_RRRR_SSSS_UUUU_MMMM_EEEE Shifted resume key _KKKK_EEEE_YYYY______SSSS_SSSS_AAAA_VVVV_EEEE Shifted save key _KKKK_EEEE_YYYY______SSSS_SSSS_UUUU_SSSS_PPPP_EEEE_NNNN_DDDD Shifted suspend key _KKKK_EEEE_YYYY______SSSS_UUUU_NNNN_DDDD_OOOO Shifted undo key _KKKK_EEEE_YYYY______SSSS_UUUU_SSSS_PPPP_EEEE_NNNN_DDDD Suspend key _KKKK_EEEE_YYYY______UUUU_NNNN_DDDD_OOOO Undo key RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE All routines return the integer _EEEE_RRRR_RRRR upon failure and an integer value other than _EEEE_RRRR_RRRR upon successful completion. PPPPaaaaggggeeee 4444 NOTES The header file _cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh automatically includes the header files _ssss_tttt_dddd_iiii_oooo_...._hhhh and _uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh. Use of the escape key by a programmer for a single character function is discouraged. When using _gggg_eeee_tttt_cccc_hhhh, _wwww_gggg_eeee_tttt_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_cccc_hhhh, or _mmmm_vvvv_wwww_gggg_eeee_tttt_cccc_hhhh, _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode and _eeee_cccc_hhhh_oooo mode should not be used at the same time. Depending on the state of the tty driver when each character is typed, the program may produce undesirable results. Note that _gggg_eeee_tttt_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_cccc_hhhh, and _mmmm_vvvv_wwww_gggg_eeee_tttt_cccc_hhhh may be macros. SSSSEEEEEEEE AAAALLLLSSSSOOOO _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_oooo_pppp_tttt_ssss(3X), _cccc_uuuu_rrrr_ssss______mmmm_oooo_vvvv_eeee(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X) PPPPaaaaggggeeee 5555